/*   Copyright (C) 2008  Jeroen v. Schagen & Youri Lima
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

using System;

namespace Engine
{
    /// <summary>
    ///     Processor is the generalisation for a processable object manager. 
    /// 
    ///     This manager is used for attaching and detaching processable
    ///     objects. Additionally it is able to process all attached objects.
    /// </summary>
    public interface IProcessor : IAdaptable
    {
        /// <summary>
        ///     Attach a processable object.
        /// </summary>
        void AddProcessable(IProcessable obj);

        /// <summary>
        ///     Dettach a processable object.
        /// </summary>
        void RemoveProcessable(IProcessable obj);

        /// <summary>
        ///     Verify that the processable object is contained.
        /// </summary>
        bool ContainsProcessable(IProcessable obj);

        /// <summary>
        ///     Retrieve all processable objects.
        /// </summary>
        IProcessable[] GetProcessables();

        /// <summary>
        ///     Process all objects over a certain time variable.
        /// </summary>
        void Process(TimeSpan time);
    }
}
